get-view

get-view

Utility for getting an assemble view from a collection object.

Install

Install with npm:

$ npm install --save get-view

Usage

Should work with any collection of vinyl files.

var getView = require('get-view');

templates example

Given the following setup code, all of the below examples would return a page from the app.views.pages collection:

var templates = require('templates');
app = templates();
app.create('page');

app.page('foo', {content: 'this is foo'});
app.page('bar.md', {content: 'this is bar'});
app.page('a/b/c/baz.md', {content: 'this is baz', base: 'a'});
app.page('test/fixtures/templates/a.tmpl');

Get a view by customizing the lookup key with a function:

var view = getView('foo.md', app.views.pages, function(key) {
  return path.basename(key, path.extname(key));
});

//=> <Page "foo" <Buffer 74 68 69 73 20 69>>

Get a view by view.path

var view = getView('a/b/c/baz.md', app.views.pages);
//=> <Page "b/c/baz.md" <Buffer 74 68 69 73>>

Get a view by view.basename

var view = getView('baz.md', app.views.pages);
//=> <Page "b/c/baz.md" <Buffer 74 68 69 73>>

Get a view by view.filename

var view = getView('baz', app.views.pages);
//=> <Page "b/c/baz.md" <Buffer 74 68 69 73>>

Get a view by view.relative

var view = getView('b/c/baz.md', app.views.pages);
//=> <Page "b/c/baz.md" <Buffer 74 68 69 73>>

About

Related projects

• assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
• gulp: The streaming build system | homepage
• match-file: Returns true when the given name matches any of the path properties on a vinyl… more | homepage
• templates: System for creating and managing template collections, and rendering templates with any node.js template engine… more | homepage
• verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage
• vinyl: Virtual file format. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. MIT

---

This file was generated by verb-generate-readme, v0.4.2, on February 01, 2017.